home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / X11R4 / cmds / X / RCS / Xserver.man,v < prev   
Encoding:
Text File  |  1990-07-04  |  16.1 KB  |  475 lines
  1. head     1.2;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    stolcke:1.2; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.2
  10. date     90.07.04.12.56.38;  author stolcke;  state Exp;
  11. branches ;
  12. next     1.1;
  13.  
  14. 1.1
  15. date     90.07.04.12.31.17;  author stolcke;  state Exp;
  16. branches ;
  17. next     ;
  18.  
  19.  
  20. desc
  21. @@
  22.  
  23.  
  24. 1.2
  25. log
  26. @*** empty log message ***
  27. @
  28. text
  29. @.TH XSERVER 1 "Release 4"  "X Version 11"
  30. .SH NAME
  31. X - X Window System server
  32. .SH SYNOPSIS
  33. .B X
  34. [:displaynumber] [-option ...] [ttyname]
  35. .SH DESCRIPTION
  36. .I X
  37. is the generic name for the X Window System server.  It is frequently a link
  38. or a copy of the appropriate server binary for driving the most frequently
  39. used server on a given machine.  The sample server from MIT supports the
  40. following platforms:
  41. .sp
  42. .ta 1.25in
  43. .in +4
  44. .nf
  45. Xqvss    Digital monochrome vaxstationII or II
  46. Xqdss    Digital color vaxstationII or II
  47. Xsun    Sun monochrome or color Sun 2, 3, or 4
  48. Xibm    IBM AED, APA and megapel PC/RT, 8514 and VGA PS/2 model 80
  49. Xapollo    Apollo monochrome or color (Domain/OS SR10.1 or SR10.2)
  50. Xhp    HP Topcat 9000s300
  51. XmacII    Apple monochrome Macintosh II
  52. Xcfbpmax    Digital color DECstation 3100
  53. Xmfbpmax    Digital monochrome DECstation 3100
  54. Xtek    Tektronix 4319 (this is the only tested configuration)
  55. .fi
  56. .in -4
  57. .SH "STARTING THE SERVER"
  58. The server is usually started from the X Display Manager program \fIxdm\fP.
  59. This utility is run from the system boot files and takes care of keeping
  60. the server running, prompting for usernames and passwords, and starting up
  61. the user sessions.  It is easily configured for sites that wish to provide
  62. nice, consistent interfaces for novice users (loading convenient sets of
  63. resources, starting up a window manager, clock, and nice selection of 
  64. terminal emulator windows).
  65. .PP
  66. Since \fIxdm\fP now handles automatic starting of the server in a portable
  67. way, the \fI-L\fP option to \fIxterm\fP is now considered obsolete.  Support
  68. for starting a login window from 4.3bsd-derived \fI/etc/ttys\fP files
  69. is no longer included.
  70. .PP
  71. Installations that run more than one window system will still need to use the
  72. \fIxinit\fP utility.  However, \fIxinit\fP is to be considered a tool for
  73. building startup scripts and is not intended for use by end users.  Site
  74. administrators are \fBstrongly\fP urged to build nicer interfaces for novice
  75. users.
  76. .PP
  77. When the sample server starts up, it takes over the display.  If you 
  78. are running on a workstation whose console is the display, you cannot log into
  79. the console while the server is running.
  80. .SH "NETWORK CONNECTIONS"
  81. The sample server supports connections made using the following reliable
  82. byte-streams:
  83. .TP 4
  84. .I TCP\/IP
  85. .br
  86. The server listens on port htons(6000+\fIn\fP), where \fIn\fP is the 
  87. display number.
  88. .TP 4
  89. .I "Sprite Pdevs"
  90. In Sprite,
  91. the sample server creates a pseudo-device \fI/hosts/\fBhostname\fP/X\fBn\fR,
  92. where \fIn\fP is the display number.
  93. .TP 4
  94. .I "DECnet"
  95. .br
  96. The server responds to connections to object \fIX$X\fBn\fR, where \fIn\fP
  97. is the display number.  This is not supported in all environments.
  98. .SH OPTIONS
  99. All of the sample servers accept the following command line options:
  100. .TP 8
  101. .B \-a \fInumber\fP
  102. sets pointer acceleration (i.e. the ratio of how much is reported to how much
  103. the user actually moved the pointer).
  104. .TP 8
  105. .B \-auth \fIauthorization-file\fP
  106. Specifies a file which contains a collection of authorization records used
  107. to authenticate access.
  108. .TP 8
  109. .B bc
  110. disables certain kinds of error checking, for bug compatibility with
  111. previous releases (e.g., to work around bugs in R2 and R3 xterms and toolkits).
  112. Deprecated.
  113. .TP 8
  114. .B \-bs
  115. disables backing store support on all screens.
  116. .TP 8
  117. .B \-c
  118. turns off key-click.
  119. .TP 8
  120. .B c \fIvolume\fP
  121. sets key-click volume (allowable range: 0-100).
  122. .TP 8
  123. .B -cc \fIclass\fP
  124. sets the visual class for the root window of color screens.
  125. The class numbers are as specified in the X protocol.
  126. Not obeyed by all servers.
  127. .TP 8
  128. .B \-co \fIfilename\fP
  129. sets name of RGB color database.
  130. .TP 8
  131. .B \-dpi \fIresolution\fP
  132. sets the resolution of the screen, in dots per inch.
  133. To be used when the server cannot determine the screen size from the hardware.
  134. .TP 8
  135. .B \-f \fIvolume\fP
  136. sets feep (bell) volume (allowable range: 0-100).
  137. .TP 8
  138. .B \-fc \fIcursorFont\fP
  139. sets default cursor font.
  140. .TP 8
  141. .B \-fn \fIfont\fP
  142. sets the default font.
  143. .TP 8
  144. .B \-fp \fIfontPath\fP
  145. sets the search path for fonts.  This path is a comma separated list of
  146. directories which the sample server searches for font databases.
  147. .TP 8
  148. .B \-help
  149. prints a usage message.
  150. .TP 8
  151. .B \-I
  152. causes all remaining command line arguments to be ignored.
  153. .TP 8
  154. .B \-ld \fIkilobytes\fP
  155. sets the data space limit of the server to the specified number of kilobytes.
  156. The default value is zero, making the data size as large as possible.  A value
  157. of -1 leaves the data space limit unchanged.  This option is not available in
  158. all operating systems.
  159. .TP 8
  160. .B \-ls \fIkilobytes\fP
  161. sets the stack space limit of the server to the specified number of kilobytes.
  162. The default value is zero, making the stack size as large as possible.  A value
  163. of -1 leaves the stack space limit unchanged.  This option is not available in
  164. all operating systems.
  165. .TP 8
  166. .B \-logo
  167. turns on the X Window System logo display in the screen-saver.
  168. There is currently no way to change this from a client.
  169. .TP 8
  170. .B nologo
  171. turns off the X Window System logo display in the screen-saver.
  172. There is currently no way to change this from a client.
  173. .TP 8
  174. .B \-p \fIminutes\fP
  175. sets screen-saver pattern cycle time in minutes.
  176. .TP 8
  177. .B \-r
  178. turns off auto-repeat.
  179. .TP 8
  180. .B r
  181. turns on auto-repeat.
  182. .TP 8
  183. .B \-s \fIminutes\fP
  184. sets screen-saver timeout time in minutes.
  185. .TP 8
  186. .B \-su
  187. disables save under support on all screens.
  188. .TP 8
  189. .B \-t \fInumber\fP
  190. sets pointer acceleration threshold in pixels (i.e. after how many pixels
  191. pointer acceleration should take effect).
  192. .TP 8
  193. .B \-to \fIseconds\fP
  194. sets default connection timeout in seconds.
  195. .TP 8
  196. .B tty\fIxx\fP
  197. ignored, for servers started the ancient way (from init).
  198. .TP 8
  199. .B v
  200. sets video-on screen-saver preference.
  201. .TP 8
  202. .B \-v
  203. sets video-off screen-saver preference.
  204. .TP 8
  205. .B \-wm
  206. forces the default backing-store of all windows to be WhenMapped;
  207. a cheap trick way of getting backing-store to apply to all windows.
  208. .TP 8
  209. .B \-x \fIextension\fP
  210. loads the specified extension at init.
  211. Not supported in most implementations.
  212. .PP
  213. You can also have the X server connect to xdm using XDMCP.  Although this is
  214. not typically useful as it doesn't allow xdm to manage the server process,
  215. it can be used to debug XDMCP implementations, and servers as a sample
  216. implementation of the server side of XDMCP.  For more information on this
  217. protocol, see the XDMCP specification in docs/XDMCP/xdmcp.ms.  The following
  218. options control the behavior of XDMCP.
  219. .TP 8
  220. .B \-query \fIhost-name\fP
  221. Enable XDMCP and send Query packets to the specified host.
  222. .TP 8
  223. .B \-broadcast
  224. Enable XDMCP and broadcast BroadcastQuery packets to the network.  The
  225. first responding display manager will be chosen for the session.
  226. .TP 8
  227. .B \-indirect \fIhost-name\fP
  228. Enable XDMCP and send IndirectQuery packets to the specified host.
  229. .TP 8
  230. .B \-port \fIport-num\fP
  231. Use an alternate port number for XDMCP packets.  Must be specified before
  232. any -query, -broadcast or -indirect options.
  233. .TP 8
  234. .B \-once
  235. Normally, the server keeps starting sessions, one after the other.  This
  236. option makes the server exit after the first session is over.
  237. .TP 8
  238. .B \-class \fIdisplay-class\fP
  239. XDMCP has an additional display qualifier used in resource lookup for
  240. display-specific options.  This option sets that value, by default it 
  241. is "MIT-Unspecified" (not a very useful value).
  242. .TP 8
  243. .B \-cookie \fIxdm-auth-bits\fP
  244. When testing XDM-AUTHENTICATION-1, a private key is shared between the
  245. server and the manager.  This option sets the value of that private
  246. data (not that it's very private, being on the command line and all...).
  247. .TP 8
  248. .B \-displayID \fIdisplay-id\fP
  249. Yet another XDMCP specific value, this one allows the display manager to
  250. identify each display so that it can locate the shared key.
  251. .PP
  252. Many servers also have device-specific command line options.  See the
  253. manual pages for the individual servers for more details.
  254. .SH "SECURITY"
  255. .PP
  256. The sample server implements a simplistic authorization protocol,
  257. MIT-MAGIC-COOKIE-1 which uses data private to authorized clients and the
  258. server.  This is a rather trivial scheme; if the client passes authorization
  259. data which is the same as the server has, it is allowed access.  This scheme
  260. is worse than the host-based access control mechanisms in environments with
  261. unsecure networks as it allows any host to connect, given that it has
  262. discovered the private key.  But in many environments, this level of
  263. security is better than the host-based scheme as it allows access control
  264. per-user instead of per-host.
  265. .PP
  266. In addition, the server provides support for a DES-based authorization
  267. scheme, XDM-AUTHORIZATION-1, which is more secure (given a secure key
  268. distribution mechanism), but as DES is not generally distributable, the
  269. implementation is missing routines to encrypt and decrypt the authorization
  270. data.  This authorization scheme can be used in conjunction with XDMCP's
  271. authentication scheme, XDM-AUTHENTICATION-1 or in isolation.
  272. .PP
  273. The authorization data is passed to the server in a private file named with
  274. the \fB-auth\fP command line option.  Each time the server is about to
  275. accept the first connection after a reset (or when the server is starting),
  276. it reads this file.  If this file contains any authorization records, the
  277. local host is not automatically allowed access to the server, and only
  278. clients which send one of the authorization records contained in the file in
  279. the connection setup information will be allowed access.  See the \fIXau\fP
  280. manual page for a description of the binary format of this file.
  281. Maintenance of this file, and distribution of its contents to remote sites
  282. for use there is left as an exercise for the reader.
  283. .PP
  284. The sample server also uses a host-based access control list for deciding
  285. whether or not to accept connections from clients on a particular machine.
  286. This list initially consists of the host on which the server is running as
  287. well as any machines listed in the file \fI/etc/X\fBn\fI.hosts\fR, where
  288. \fBn\fP is the display number of the server.  Each line of the file should
  289. contain either an Internet hostname (e.g. expo.lcs.mit.edu) or a DECnet
  290. hostname in double colon format (e.g. hydra::).  There should be no leading
  291. or trailing spaces on any lines.  For example:
  292. .sp
  293. .in +8
  294. .nf 
  295. joesworkstation
  296. corporate.company.com
  297. star::
  298. bigcpu::
  299. .fi
  300. .in -8
  301. .PP
  302. Users can add or remove hosts from this list and enable or disable access
  303. control using the \fIxhost\fP command from the same machine as the server.
  304. For example:
  305. .sp
  306. .in +8
  307. .nf
  308. %  xhost +janesworkstation
  309. janesworkstation being added to access control list
  310. %  xhost -star::
  311. public:: being removed from access control list
  312. %  xhost +
  313. all hosts being allowed (access control disabled)
  314. %  xhost -
  315. all hosts being restricted (access control enabled)
  316. %  xhost
  317. access control enabled (only the following hosts are allowed)
  318. joesworkstation
  319. janesworkstation
  320. corporate.company.com
  321. bigcpu::
  322. .fi
  323. .in -8
  324. .PP
  325. Unlike some window systems, X does not have any notion of window operation
  326. permissions or place any restrictions on what a client can do; if a program can
  327. connect to a display, it has full run of the screen.  Sites that have better
  328. authentication and authorization systems (such as Kerberos) might wish to make
  329. use of the hooks in the libraries and the server to provide additional
  330. security models.
  331. .SH "SIGNALS"
  332. The sample server attaches special meaning to the following signals:
  333. .TP 8
  334. .I SIGHUP
  335. This signal causes the server to close all existing connections, free all
  336. resources, and restore all defaults.  It is sent by the display manager
  337. whenever the main user's main application (usually an \fIxterm\fP or window
  338. manager) exits to force the server to clean up and prepare for the next
  339. user.
  340. .TP 8
  341. .I SIGTERM
  342. This signal causes the server to exit cleanly.
  343. .TP 8
  344. .I SIGUSR1
  345. This signal is used quite differently from either of the above.  When the
  346. server starts, it checks to see if it has inherited SIGUSR1 as SIG_IGN
  347. instead of the usual SIG_DFL.  In this case, the server sends a SIGUSR1 to
  348. it's parent process after it has set up the various connection schemes.  Xdm
  349. uses this feature to recognize when connecting to the server is possible.
  350. .SH "FONTS"
  351. Fonts are usually stored as individual files in directories.  The list of
  352. directories in which the server looks when trying to open a font is controlled
  353. by the \fIfont path\fP.  Although most sites will choose to have the server
  354. start up with the appropriate font path (using the \fI-fp\fP option mentioned
  355. above), it can be overridden using the \fIxset\fP program.
  356. .PP
  357. The default font path for
  358. the sample server contains four directories:
  359. .TP 8
  360. .I /X11/R4/lib/fonts/misc/md
  361. This directory contains several miscellaneous fonts that are useful on all
  362. systems.  It contains a very small family of fixed-width fonts (\fB6x10\fP, 
  363. \fB6x12\fP, \fB6x13\fP, \fB8x13\fP, \fB8x13bold\fP, and \fB9x15\fP) and the
  364. cursor font.  It also has font name aliases for the commonly used fonts
  365. \fBfixed\fP and \fBvariable\fP.
  366. .TP 8
  367. .I /X11/R4/lib/fonts/75dpi/md
  368. This directory contains fonts contributed by Adobe Systems, Inc. and
  369. Digital Equipment Corporation and by Bitstream, Inc.
  370. for 75 dots per inch displays.  An integrated selection of sizes, styles, 
  371. and weights are provided for each family.
  372. .TP 8
  373. .I /X11/R4/lib/fonts/100dpi/md
  374. This directory contains versions of
  375. the fonts in the \fI75dpi\fP directory
  376. for 100 dots per inch displays.
  377. .TP 8
  378. .I /X11/R4/lib/fonts/xproof/md
  379. This directory contains special fonts required by the
  380. \fIxproof(1)\fP ditroff previewer.
  381. .PP
  382. Font databases are created by running the \fImkfontdir\fP program in the
  383. directory containing the compiled versions of the fonts (the \fI.snf\fP files).
  384. Whenever fonts are added to a directory, \fImkfontdir\fP should be rerun
  385. so that the server can find the new fonts.  \fBIf \fImkfontdir\fP is not
  386. run, the server will not be able to find any fonts in the directory.\fR
  387. .SH DIAGNOSTICS
  388. Too numerous to list them all.
  389. If run from \fIinit(8)\fP, errors are logged in the file \fI/usr/adm/X*msgs\fP,
  390. .SH FILES
  391. .TP 30
  392. /etc/X*.hosts
  393. Initial access control list
  394. .TP 30
  395. /X11/R4/lib/fonts/misc, /X11/R4/lib/fonts/75dpi, /X11/R4/lib/fonts/100dpi, /X11/R4/lib/fonts/xproof
  396. Font directories
  397. .TP 30
  398. /X11/R4/lib/rgb/rgb.txt
  399. Color database
  400. .TP 30
  401. /hosts/\fIhostname\fP/X*
  402. Sprite pseudo-device
  403. .TP 30
  404. /usr/adm/X*msgs
  405. Error log file
  406. .SH "SEE ALSO"
  407. X(1), xdm(1), mkfontdir(1),
  408. xinit(1), xterm(1), twm(1), xhost(1), xset(1), xsetroot(1), 
  409. ttys(5), init(8), Xqdss(1), Xqvss(1), Xsun(1), Xapollo(1), XmacII(1)
  410. .I "X Window System Protocol,"
  411. .I "Definition of the Porting Layer for the X v11 Sample Server,"
  412. .I "Strategies for Porting the X v11 Sample Server,"
  413. .I "Godzilla's Guide to Porting the X V11 Sample Server"
  414. .SH BUGS
  415. The option syntax is inconsistent with itself and \fIxset(1)\fP.
  416. .PP
  417. The acceleration option should take a numerator and a denominator like the
  418. protocol.
  419. .PP
  420. If
  421. .I X
  422. dies before its clients, new clients won't be able to connect until all
  423. existing connections have their TCP TIME_WAIT timers expire.
  424. .PP
  425. The color database is missing a large number of colors.  However, there
  426. doesn't seem to be a better one available that can generate RGB values
  427. tailorable to particular displays.
  428. .PP
  429. .SH COPYRIGHT
  430. Copyright 1984, 1985, 1986, 1987, 1988, 1989, Massachusetts Institute of Technology.
  431. .br
  432. See \fIX(1)\fP for a full statement of rights and permissions.
  433. .SH AUTHORS
  434. The sample server was originally written by Susan Angebranndt, Raymond
  435. Drewry, Philip Karlton, and Todd Newman, from Digital Equipment
  436. Corporation, with support from a large cast.  It has since been
  437. extensively rewritten by Keith Packard and Bob Scheifler, from MIT.
  438. @
  439.  
  440.  
  441. 1.1
  442. log
  443. @Initial revision
  444. @
  445. text
  446. @d61 4
  447. a64 3
  448. .I "Unix Domain"
  449. The sample server uses \fI/tmp/.X11-unix/X\fBn\fR as the filename for 
  450. the socket, where \fIn\fP is the display number.
  451. d330 1
  452. a330 1
  453. the sample server contains three directories:
  454. d332 1
  455. a332 1
  456. .I /usr/lib/X11/fonts/misc
  457. d339 1
  458. a339 1
  459. .I /usr/lib/X11/fonts/75dpi
  460. d345 1
  461. a345 1
  462. .I /usr/lib/X11/fonts/100dpi
  463. d349 4
  464. d367 1
  465. a367 1
  466. /usr/lib/X11/fonts/misc, /usr/lib/X11/fonts/75dpi, /usr/lib/X11/fonts/100dpi 
  467. d370 1
  468. a370 1
  469. /usr/lib/X11/rgb.txt
  470. d373 2
  471. a374 2
  472. /tmp/.X11-unix/X*
  473. Unix domain socket
  474. @
  475.